Skip to main content
Feedback

Migrate from 5.x.x to 6.3.0 (Same and Different modes)

The complete migration process from a 5.x.x environment to a 6.3.0 environment should be performed within the 6.3.0 installer, in the migrate_5x_to_6 folder. The tool runs inside your existing APIM 5.x.x environment. It migrates entities, including users, certificates, API definitions, packages, and applications, from APIM 5.x.x to Local Edition 6.3.0.

It tracks the progress of each entity in a local mapping table (migration_entity_mapping) within the 5.x.x database to ensure that already-migrated entities are skipped and failed ones are retried automatically. Once migration is complete, Local Edition 6.3.0 syncs from Cloud API Management (SaaS).

About the migration package

The 6.3.0 migration package is available in the 6.3.0 GA installer. It contains:

  • build-images.sh: Scripts to build the migration container image.
  • push-images.sh: Scripts to push the migration container image.
  • migrate_5x_to_6/templates/k8s/: Kubernetes credential template files. Update the Kubernetes credential template file only when migrating from one K8s cluster to another.
  • migrate_5x_to_6/templates/swarm/: Docker Swarm credential template files. Update the Docker Swarm credentials template file only when migrating from Swarm to K8s.
  • migration-override.env: Configuration variables file.
  • migrate_5x_to_6/scripts/: Deploy and undeploy scripts deploy.sh, undeploy.sh, and swarm/create_secrets.sh.

Steps to migrate

Different deployment modes (untethered → tethered)

Follow these steps in order to complete the migration from Local Edition 5.x.x to 6.3.0 between the different deployment modes — from untethered to tethered:

  1. Configuring prerequisites for migration across deployment modes
  2. Building and deploying the migration pod for different deployment modes
  3. Migrating your data
  4. Recovery and re-runs
  5. Progress and reports
  6. Performing post-migration steps

Same deployment modes (untethered → untethered or tethered → tethered)

Follow these steps in order to complete the migration from Local Edition 5.x.x to 6.3.0 within the same deployment mode — from untethered to untethered or from tethered to tethered:

  1. Configuring prerequisites for migration within the same deployment mode
  2. Building and deploying the migration pod for same deployment modes
  3. Migrating your data
  4. Performing post-migration steps
note

For migration from 5.x.x to 6.3.0 within the same deployment mode, only the prerequisites for migration and build and deploy steps are specific to 6.3.0. The Migrating your data step is the same as in Migrate from 5.x.x to 6.1.0 or 6.2.0 (Same mode).

On this Page